[FX-5062] Update Product Docs with Blackout Period #592
Conversation
✅ Deploy Preview for cobalt-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| - While a blackout period is active, no new scans will be initiated, and any in-progress scans will be paused. | ||
| - Ensure your blackout periods do not overlap with critical security testing windows to maintain continuous vulnerability assessment. | ||
| - Consider setting reminders for upcoming blackout periods to avoid unintended lapses in security coverage. |
There was a problem hiding this comment.
I don't understand which reminders.
There was a problem hiding this comment.
AI added in this one, and I think it means to just set up reminders for yourself to know when the blackout periods are (not in-app but something nice to do on your own). I can remove it if it's confusing in any way.
There was a problem hiding this comment.
Recently we've been using red rectangles to highlight buttons or sections in the docs. Like in the integration builder. Would be nice to have similar visuals added in new screenshots.
There was a problem hiding this comment.
To be honest, the visuals are all over the place in our docs. Historically, the tech writers used the purple to highlight things in screenshots. I think Design needs to set standards around this one.
Co-authored-by: Akos Kitta <[email protected]>
Co-authored-by: Akos Kitta <[email protected]>
Changelog
Added
Changed
Preview This Change
To see how this change looks in production, scroll down to Deploy Preview. Select the link that looks like
https://deploy-preview-<num>--cobalt-docs.netlify.app/Variables
Help us support a “Write once, publish everywhere” single source of truth. If you see a line that looks like:
{{% asset-categories %}}You’ve found a shortcode that we include in multiple documents.
You’ll find the content of the shortcode in the following directory:
https://github.com/cobalthq/cobalt-product-public-docs/tree/main/layouts/shortcodes
That shortcode has the same base name as what you see in the PR, such as
asset-categories.html.Checklist for PR Author
[ ] Did you check for broken links and alt text?
Be sure to check for broken links and Alt Text issues. We have a partially automated process,
as described in this section of our repository README:
Test Links and Alt Attributes.